/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 */

/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

/*
 * Modifications Copyright OpenSearch Contributors. See
 * GitHub history for details.
 */

package org.opensearch.example.painlessallowlist;

/**
 * An example of an instance to be allowlisted for use by painless scripts.
 * <p>
 * Each of the members and methods below are allowlisted for use in search scripts but only from this instance.
 */
public class ExampleAllowlistedInstance {
    private final int value;

    /**
     * Instantiate this instance with a value.
     *
     * @param value A base value to set.
     */
    public ExampleAllowlistedInstance(int value) {
        this.value = value;
    }

    /**
     * A method that can be allowlisted to add an input value to the stored base value.
     *
     * @param value The value to add.
     * @return The sum of the base value and the new value. The base value remains unchanged.
     */
    public int addValue(int value) {
        return this.value + value;
    }

    /**
     * Get the stored base value.
     *
     * @return The base value.
     */
    public int getValue() {
        return value;
    }
}
